home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / ALgetfillpoint.z / ALgetfillpoint
Encoding:
Text File  |  1998-10-20  |  6.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm))))                                        AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetfillpoint, ALsetfillpoint - (obsolete) control sssseeeelllleeeecccctttt(((()))) or ppppoooollllllll(((())))
  10.      behavior of an audio port
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      lllloooonnnngggg AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  16.  
  17.      iiiinnnntttt AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt,,,, ccccoooonnnnsssstttt lllloooonnnngggg ffffiiiillllllllppppooooiiiinnnntttt))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _p_o_r_t        expects an AAAALLLLppppoooorrrrtttt structure.  This structure is the returned
  21.                  value of an AAAALLLLooooppppeeeennnnppppoooorrrrtttt((((3333ddddmmmm)))) call.
  22.  
  23.      _f_i_l_l_p_o_i_n_t   expects a long value, the fillpoint, in samples.
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt and AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt are obsolete and are provided for
  27.      backward compatibility.  The preferred functions are _a_l_G_e_t_F_i_l_l_P_o_i_n_t(_3_d_m)
  28.      and _a_l_S_e_t_F_i_l_l_P_o_i_n_t(_3_d_m), both of which use units of sample frames.
  29.  
  30.      AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) returns the current fillpoint of a port.
  31.  
  32.      AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) sets the current fillpoint of a port.
  33.  
  34.      Used with AAAALLLLggggeeeettttffffdddd((((3333ddddmmmm)))) and sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))), controlling the
  35.      fillpoint lets you programmatically relinquish control to other
  36.      processes.
  37.  
  38.      An input port will trigger the return from a sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))) call
  39.      when there are at least _f_i_l_l_p_o_i_n_t samples available to be read.
  40.  
  41.      An output port will trigger the return from a sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))) call
  42.      when there are more than _f_i_l_l_p_o_i_n_t unfilled samples spaces.
  43.  
  44.      AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt does not perform any validity checking on the fillpoint;
  45.      it is up to the application to pass in a correct value.
  46.  
  47.      The calls AAAALLLLrrrreeeeaaaaddddssssaaaammmmppppssss((((3333ddddmmmm)))) and AAAALLLLwwwwrrrriiiitttteeeessssaaaammmmppppssss((((3333ddddmmmm)))) may change the fillpoint
  48.      so you should set it just before you call sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))).
  49.  
  50.      AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) can fail for the following reason:
  51.  
  52.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT   _p_o_r_t is invalid or null.
  53.  
  54.      AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) can fail for the following reasons:
  55.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT
  56.           _p_o_r_t is invalid or null.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm))))                                        AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  75.      Upon successful completion AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) returns a non-negative
  76.      number. Otherwise, AAAALLLLggggeeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) returns -1 and sets an error
  77.      number which can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  78.  
  79.      Upon successful completion AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) returns 0.  Otherwise,
  80.      AAAALLLLsssseeeettttffffiiiillllllllppppooooiiiinnnntttt((((3333ddddmmmm)))) returns -1 and sets an error number which can be
  81.      retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  82.  
  83. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  84.      ALopenport(3dm), ALgetfd(3dm), ALgetqueuesize(3dm), ALgetfillable(3dm),
  85.      ALgetfilled(3dm), oserror(3C)
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.